口座振替サービス自動売上 API一覧

HTTP仕様（.idPass）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

RegisterRecurringPlan 自動売上プラン登録

自動売上のプランを登録します。登録したプランを用いて、金額や課金サイクルを指定せずに定義登録をすることができます。
※プランIDには重複しないユニークなIDを指定してください。
※プランは100件まで登録可能です。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
PlanID		必須半角英数32桁プランID 加盟店様が自動売上プランを識別するための値を設定します。
PlanName		必須全半角200バイトプラン名
Description		必須全半角300バイトプラン説明
Method		必須半角数字2桁固定課金手段以下のいずれかを指定します。 02：口座振替 03：口座振替セレクト
Amount		必須半角数字8桁利用金額 Method=02（口座振替）の場合、最大桁数は7桁です。 Method=03（口座振替セレクト）の場合、最大桁数は8桁です。
Tax		半角数字7桁税送料税送料を指定した場合は、利用金額+税送料が自動売上金額となります。
ChargeMonth		半角数字記号36桁課金月自動売上を行う月を01～12で指定します。 "\|"で区切ることにより複数の月を指定可能です。省略した場合は、毎月として扱われます。
ChargeDay		半角数字2桁課金基準日自動売上を行う日を指定します。 Method=03（口座振替セレクト）の場合に必須です。 Method=02（口座振替）の場合、27のみ指定可能です。 Method=03（口座振替セレクト）の場合、05,06,23,27のうちいずれかを指定可能です。

URL

/payment/RegisterRecurringPlan.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&PlanID=planid001&PlanName=プラン名&Description=プラン説明&Method=02&Amount=100

レスポンス

正常

ShopID		半角英数13桁ショップID
PlanID		半角英数32桁プランID

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&PlanID=planid001

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ChangeRecurringPlan 自動売上プラン変更

プランIDを指定して、自動売上のプラン内容を変更します。
※変更対象のプランを利用して登録した定義が存在する場合、プラン変更の内容は定義へ反映されません。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
PlanID		必須半角英数32桁プランID 加盟店様が自動売上プランを識別するための値を設定します。
PlanName		全半角200バイトプラン名
Description		全半角300バイトプラン説明
Method		必須半角数字2桁固定課金手段以下のいずれかを指定します。 02：口座振替 03：口座振替セレクト
Amount		半角数字8桁利用金額 Method=02（口座振替）の場合、最大桁数は7桁です。 Method=03（口座振替セレクト）の場合、最大桁数は8桁です。
Tax		半角数字7桁税送料税送料を指定した場合は、利用金額+税送料が自動売上金額となります。
ChargeMonth		半角数字記号36桁課金月自動売上を行う月を01～12で指定します。 "\|"で区切ることにより複数の月を指定可能です。
ChargeDay		半角数字2桁課金基準日自動売上を行う日を指定します。 Method=02（口座振替）の場合、27のみ指定可能です。 Method=03（口座振替セレクト）の場合、05,06,23,27のうちいずれかを指定可能です。

URL

/payment/ChangeRecurringPlan.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&PlanID=planid001&Method=02&Amount=300000

レスポンス

正常

ShopID		半角英数13桁ショップID
PlanID		半角英数32桁プランID
PlanName		全半角200バイトプラン名
Description		全半角300バイトプラン説明
Method		半角数字2桁固定課金手段
Amount		半角数字8桁利用金額
Tax		半角数字7桁税送料
ChargeMonth		半角数字記号36桁課金月
ChargeDay		半角数字2桁課金基準日

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&PlanID=planid001&PlanName=プラン名&Description=プラン説明&Method=02&Amount=300000&Tax=0&ChargeMonth=01|02|03|04|05|06|07|08|09|10|11|12&ChargeDay=27

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RegisterRecurringAccounttrans 自動売上定義登録口座振替

自動売上定義を登録すると、指定された売上対象の口座に対して、指定されたスケジュールで定期的に自動売上処理を行い、自動売上結果ファイルを通知します。 ※自動売上IDには重複しないユニークなIDを指定してください。 ※自動売上IDは、口座振替の自動売上結果ファイルの「自由項目」に設定されます。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
RecurringID		必須半角英数15桁自動売上ID 加盟店様が自動売上定義を識別するための値を設定します。本値は自動売上結果ファイルの「自由項目」に設定されます。
PlanID		半角英数32桁プランID 加盟店様が登録したプランIDを指定します。
Amount		半角数字7桁利用金額プランIDが指定されていない場合、必須です。 ※プランIDが指定されている場合、利用金額は指定できません。
Tax		半角数字7桁税送料税送料を指定した場合は、利用金額+税送料が自動売上金額となります。 ※プランIDが指定されている場合、税送料は指定できません。
ChargeMonth		半角数字記号36桁課金月自動売上を行う月を01～12で指定します。 "\|"で区切ることにより複数の月を指定可能です。省略した場合は、毎月として扱われます。 ※プランIDが指定されている場合、課金月は指定できません。
ChargeStartDate		半角数字8桁固定課金開始日 yyyyMMdd形式 3ヶ月以内の日付を指定してください。省略した場合は、翌日が指定されます。
ChargeStopDate		半角数字8桁固定課金停止日 yyyyMMdd形式省略した場合は、無期限として扱われます。
SIteID		必須半角英数13桁サイトID
SitePass		必須半角英数64桁サイトパスワード
MemberID		必須半角英数記号60桁会員ID
PrintStr		必須半角カナ数字記号15桁通帳記載内容引き落とし時に、通帳に印字する内容以下の文字が利用可能です。・１バイト数字・一部※を除く半角カナ文字・半角濁点・半角半濁点・ ,.()/- ・ ※除外される半角カナ：ｦｧｨｩｪｫｬｭｮｯまた、以下の埋込変数が使用可能です。 %Y : 課金年(西暦下2桁)に展開されます。 %M : 課金月(2桁)に展開されます。 %D : 課金日(2桁)に展開されます。
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3

URL

/payment/RegisterRecurringAccounttrans.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&RecurringID=recurringid001&PlanID=planid001&SIteID=tsite99887902&SitePass=PASSWORD&MemberID=memberid001&PrintStr=ｷｻｲﾅｲﾖｳ

レスポンス

正常

ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
ChargeDay		半角数字2桁課金基準日
ChargeMonth		半角数字記号36桁課金月
ChargeStartDate		半角数字8桁課金開始日
ChargeStopDate		半角数字8桁課金停止日
NextChargeDate		半角数字8桁次回課金日次回(初回)の課金日を返却します。
Method		半角英数13桁課金手段固定値"RECURRING_ACCOUNTTRANS"(口座振替)を返却します。
SiteID		半角英数13桁サイトID
MemberID		半角英数記号60桁会員ID
PrintStr		半角カナ数字記号15桁通帳記載内容

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&RecurringID=recurringid001&Amount=300000&Tax=0&ChargeDay=27&ChargeMonth=01|02|03|04|05|06|07|08|09|10|11|12&ChargeStartDate=20221212&ChargeStopDate=&NextChargeDate=20230127&Method=RECURRING_ACCOUNTTRANS&SiteID=tsite99887902&MemberID=memberid001&PrintStr=ｷｻｲﾅｲﾖｳ

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

RegisterRecurringSelect 自動売上定義登録口座振替セレクト

自動売上の定義を登録します。
自動売上定義を登録すると、指定された売上対象の口座に対して、指定されたスケジュールで定期的に自動売上処理を行い、自動売上結果ファイルを通知します。
※自動売上IDには重複しないユニークなIDを指定してください。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
RecurringID		必須半角英数15桁自動売上ID 加盟店様が自動売上定義を識別するための値を設定します。本値は自動売上結果ファイルの「自由項目」に設定されます。
PlanID		半角英数32桁プランID 加盟店様が登録したプランIDを指定します。
Amount		半角数字8桁利用金額プランIDが指定されていない場合、必須です。 ※プランIDが指定されている場合、利用金額は指定できません。
Tax		半角数字7桁税送料税送料を指定した場合は、利用金額+税送料が自動売上金額となります。 ※プランIDが指定されている場合、税送料は指定できません。
ChargeMonth		半角数字記号36桁課金月自動売上を行う月を01～12で指定します。 "\|"で区切ることにより複数の月を指定可能です。省略した場合は、毎月として扱われます。 ※プランIDが指定されている場合、課金月は指定できません。
ChargeDay		半角数字2桁固定課金基準日プランIDが指定されていない場合、必須です。自動売上を行う日を05,06,23,27のいずれかから指定します。 ※プランIDが指定されている場合、課金日は指定できません。
ChargeStartDate		半角数字8桁固定課金開始日 yyyyMMdd形式 3ヶ月以内の日付を指定してください。省略した場合は、翌日が指定されます。
ChargeStopDate		半角数字8桁固定課金停止日 yyyyMMdd形式省略した場合は、無期限として扱われます。
SIteID		必須半角英数13桁サイトID
SitePass		必須半角英数64桁サイトパスワード
MemberID		必須半角英数記号60桁会員ID
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
Remarks		半角英数カナ記号15桁請求内容請求内容を指定します。指定可能な文字は半角英数(大文字のみ) 半角カタカナ(大文字のみ) (). -(半角ハイフン)です。未指定の場合は、加盟店様のショップ名カナを印字します。
CheckMode		半角英字16桁口座有効性チェックモード口座の有効性チェックを行わない場合、以下を指定します。 NOCHECK_ACCOUNT：バッチ処理時の口座の有効性チェックを行いません。本パラメータを指定すると、口座が利用可能ではない状態（口座申込確定から30日以内等）でも請求依頼を受け付けます。 ※請求依頼は受け付けますが、金融機関側で「依頼書未着」エラーとなる可能性があります。

URL

/payment/RegisterRecurringSelect.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&RecurringID=recurringid001s&Amount=299999&SIteID=tsite99887902&SitePass=PASSWORD&MemberID=memberid001&Remarks=ｾｲｷﾕｳﾅｲﾖｳ&CheckMode=NOCHECK_ACCOUNT

レスポンス

正常

ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
NextChargeDate		半角数字8桁次回課金日次回(初回)の課金日を返却します。 ※振替指定日を返却します。休日の場合、翌営業日が振替日となります。振替日は口座振替(セレクト) カレンダーを参照ください。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&RecurringID=recurringid001s&NextChargeDate=20230105

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

UnregisterRecurring 自動売上定義解除

自動売上の定義を解除します。 ※当日が課金日の場合は解除できません。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
RecurringID		必須半角英数15桁自動売上ID 解除対象の自動売上IDを設定します。

URL

/payment/UnregisterRecurring.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&RecurringID=recurringid001

レスポンス

正常

口座振替

ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
ChargeDay		半角数字2桁課金基準日
ChargeMonth		半角数字記号36桁課金月
ChargeStartDate		半角数字8桁課金開始日
ChargeStopDate		半角数字8桁課金停止日
NextChargeDate		半角数字8桁次回課金日空文字を返します。
Method		課金手段 "RECURRING_ACCOUNTTRANS"(口座振替)を返却します。
CardNo		半角数字16桁カード番号空文字を返します。
Expire		半角数字4桁有効期限空文字を返します。
SiteID		半角英数13桁サイトID
MemberID		半角英数記号60桁会員ID
PrintStr		半角カナ数字記号15桁通帳記載内容

口座振替セレクト

ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
ChargeDay		半角数字2桁課金基準日
ChargeMonth		半角数字記号36桁課金月
ChargeStartDate		半角数字8桁課金開始日
ChargeStopDate		半角数字8桁課金停止日
NextChargeDate		半角数字8桁次回課金日空文字を返します。
Method		課金手段 "RECURRING_SELECT"(口座振替セレクト)を返却します。
SiteID		半角英数13桁サイトID
MemberID		半角英数記号60桁会員ID
Remarks		半角英数カナ記号15桁請求内容

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系口座振替

ShopID=tshop11223344&RecurringID=recurringid001&Amount=300000&Tax=0&ChargeDay=27&ChargeMonth=01|02|03|04|05|06|07|08|09|10|11|12&ChargeStartDate=20221212&ChargeStopDate=&NextChargeDate=&Method=RECURRING_ACCOUNTTRANS&CardNo=&Expire=&SiteID=tsite99887902&MemberID=memberid001&PrintStr=ｷｻｲﾅｲﾖｳ

レスポンスパラメータ：正常系口座振替セレクト

ShopID=tshop11223344&RecurringID=recurringid001s&Amount=299999&Tax=0&ChargeDay=05&ChargeMonth=01|02|03|04|05|06|07|08|09|10|11|12&ChargeStartDate=20221212&ChargeStopDate=&NextChargeDate=&Method=RECURRING_SELECT&SiteID=tsite99887902&MemberID=memberid001&Remarks=ｾｲｷﾕｳﾅｲﾖｳ

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ChangeRecurring 自動売上定義金額変更

自動売上定義の金額を変更します。
※当日が課金日の場合は変更できません。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
RecurringID		必須半角英数15桁自動売上ID 変更対象の自動売上IDを設定します。
Amount		必須半角数字7桁利用金額
Tax		半角数字7桁税送料税送料を指定した場合は、利用金額+税送料が自動売上金額となります。

URL

/payment/ChangeRecurring.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&RecurringID=recurringid001&Amount=100

レスポンス

正常

口座振替

ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
ChargeDay		半角数字2桁課金基準日
ChargeMonth		半角数字記号36桁課金月
ChargeStartDate		半角数字8桁課金開始日
ChargeStopDate		半角数字8桁課金停止日
NextChargeDate		半角数字8桁次回課金日次回の課金日を返却します。
Method		課金手段 "RECURRING_ACCOUNTTRANS"(口座振替)を返却します。
CardNo		半角数字16桁カード番号空文字を返します。
Expire		半角数字4桁有効期限空文字を返します。
SiteID		半角英数13桁サイトID
MemberID		半角英数記号60桁会員ID
PrintStr		半角カナ数字記号15桁通帳記載内容

口座振替セレクト

ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
ChargeDay		半角数字2桁課金基準日
ChargeMonth		半角数字記号36桁課金月
ChargeStartDate		半角数字8桁課金開始日
ChargeStopDate		半角数字8桁課金停止日
NextChargeDate		半角数字8桁次回課金日次回の課金日を返却します。 ※振替指定日を返却します。休日の場合、翌営業日が振替日となります。振替日は口座振替(セレクト) カレンダーを参照ください。
Method		課金手段 "RECURRING_SELECT"(口座振替セレクト)を返却します。
SiteID		半角英数13桁サイトID
MemberID		半角英数記号60桁会員ID
Remarks		半角英数カナ記号15桁請求内容

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系口座振替

ShopID=tshop11223344&RecurringID=recurringid001&Amount=100&Tax=0&ChargeDay=27&ChargeMonth=01|02|03|04|05|06|07|08|09|10|11|12&ChargeStartDate=20221212&ChargeStopDate=&NextChargeDate=20230127&Method=RECURRING_ACCOUNTTRANS&CardNo=&Expire=&SiteID=tsite99887902&MemberID=memberid001&PrintStr=ｷｻｲﾅｲﾖｳ

レスポンスパラメータ：正常系口座振替セレクト

ShopID=tshop11223344&RecurringID=recurringid001&Amount=100&Tax=0&ChargeDay=05&ChargeMonth=01|02|03|04|05|06|07|08|09|10|11|12&ChargeStartDate=20221212&ChargeStopDate=&NextChargeDate=20230105&Method=RECURRING_SELECT&SiteID=tsite99887902&MemberID=memberid001&Remarks=ｾｲｷﾕｳﾅｲﾖｳ

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ChangeRecurringAccounttrans 自動売上定義変更口座振替

自動売上の定義を変更します。
※当日が課金日の場合は変更できません。
※課金月を変更する場合、次回課金日がクリアされ、新たな次回課金日を算出します。
変更前の次回課金日での課金は発生しないためご注意ください。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
RecurringID		必須半角英数15桁自動売上ID 変更対象の自動売上IDを設定します。
PlanID		半角英数32桁プランID 加盟店様が登録したプランIDを指定します。
Amount		半角数字7桁利用金額プランIDが指定されている場合、利用金額は指定できません。
Tax		半角数字7桁税送料税送料を指定した場合は、利用金額+税送料が自動売上金額となります。プランIDが指定されている場合、税送料は指定できません。
ChargeMonth		半角数字記号36桁課金月自動売上を行う月を01～12で指定します。 "\|"で区切ることにより複数の月を指定可能です。 ※プランIDが指定されている場合、課金月は指定できません。
ChargeStopDate		半角数字8桁固定課金停止日 yyyyMMdd形式
UpdateType		1桁固定更新区分課金停止日を更新するかを指定するフラグです。以下のいずれかを設定します。 1:課金停止日を更新する（デフォルト） 2:課金停止日を更新しない ※1を指定した場合、ChargeStopDateが未指定でもnull更新されます。

URL

/payment/ChangeRecurringAccounttrans.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&RecurringID=recurringid001&ChargeMonth=05

レスポンス

正常

ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
ChargeMonth		半角数字記号36桁課金月
ChargeDay		半角数字2桁課金基準日
ChargeStartDate		半角数字8桁課金開始日
ChargeStopDate		半角数字8桁課金停止日
NextChargeDate		半角数字8桁次回課金日次回の課金日を返却します。
Method		課金手段 "RECURRING_ACCOUNTTRANS"(口座振替)を返却します。
SiteID		半角英数13桁サイトID
MemberID		半角英数記号60桁会員ID
PrintStr		半角カナ数字記号15桁通帳記載内容

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&RecurringID=recurringid001&Amount=50&Tax=0&ChargeMonth=05&ChargeDay=27&ChargeStartDate=20221212&ChargeStopDate=&NextChargeDate=20230527&Method=RECURRING_ACCOUNTTRANS&SiteID=tsite99887902&MemberID=memberid001&PrintStr=ｷｻｲﾅｲﾖｳ

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ChangeRecurringSelect 自動売上定義変更口座振替セレクト

自動売上の定義を変更します。
※当日が課金日の場合は変更できません。
※課金月、課金基準日を変更する場合、次回課金日がクリアされ、新たな次回課金日を算出します。
変更前の次回課金日での課金は発生しないためご注意ください。
※口座振替(セレクト) カレンダーにて公開されていない振替指定日が次回課金日となる場合、定義の変更はできません。
変更は対象の年間カレンダーが公表されるまでお待ちください。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
RecurringID		必須半角英数15桁自動売上ID 変更対象の自動売上IDを設定します。
PlanID		半角英数32桁プランID 加盟店様が登録したプランIDを指定します。
Amount		半角数字8桁利用金額プランIDが指定されている場合、利用金額は指定できません。
Tax		半角数字7桁税送料税送料を指定した場合は、利用金額+税送料が自動売上金額となります。プランIDが指定されている場合、税送料は指定できません。
ChargeMonth		半角数字記号36桁課金月自動売上を行う月を01～12で指定します。 "\|"で区切ることにより複数の月を指定可能です。 ※プランIDが指定されている場合、課金月は指定できません。
ChargeDay		半角数字2桁固定課金基準日自動売上を行う日を05,06,23,27のいずれかから指定します。 ※プランIDが指定されている場合、課金日は指定できません。
ChargeStopDate		半角数字8桁固定課金停止日 yyyyMMdd形式
UpdateType		半角数字1桁固定更新区分課金停止日を更新するかを指定するフラグです。以下のいずれかを設定します。 1:課金停止日を更新する（デフォルト） 2:課金停止日を更新しない ※1を指定した場合、ChargeStopDateが未指定でもnull更新されます。

URL

/payment/ChangeRecurringSelect.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&RecurringID=recurringid001&ChargeMonth=02

レスポンス

正常

ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
Amount		半角数字8桁利用金額
Tax		半角数字7桁税送料
ChargeMonth		半角数字記号36桁課金月
ChargeDay		半角数字2桁課金基準日
ChargeStartDate		半角数字8桁課金開始日
ChargeStopDate		半角数字8桁課金停止日
NextChargeDate		半角数字8桁次回課金日次回の課金日を返却します。 ※振替指定日を返却します。休日の場合、翌営業日が振替日となります。振替日は口座振替(セレクト) カレンダーを参照ください。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

ShopID=tshop11223344&RecurringID=recurringid001&Amount=100&Tax=10&ChargeMonth=02&ChargeDay=05&ChargeStartDate=20221212&ChargeStopDate=&NextChargeDate=20230205

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchRecurring 自動売上定義参照

自動売上の定義を参照します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
RecurringID		必須半角英数15桁自動売上ID 参照対象の自動売上IDを設定します。

URL

/payment/SearchRecurring.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&RecurringID=recurringid001

レスポンス

正常

口座振替

ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
ChargeDay		半角数字2桁課金日
ChargeMonth		半角数字記号36桁課金月
ChargeStartDate		半角数字8桁課金開始日
ChargeStopDate		半角数字8桁課金停止日
NextChargeDate		半角数字8桁次回課金日次回の課金日を返却します。自動売上定義が課金停止日に到達しているか、解除されている場合は、空文字を返却します。
Method		課金手段 "RECURRING_ACCOUNTTRANS"(口座振替)を返却します。
CardNo		半角数字16桁カード番号
Expire		半角数字4桁有効期限
SiteID		半角英数13桁サイトID
MemberID		半角英数60桁会員ID
PrintStr		半角カナ数字記号15桁通帳記載内容

口座振替セレクト

ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
ChargeDay		半角数字2桁課金日
ChargeMonth		半角数字記号36桁課金月
ChargeStartDate		半角数字8桁課金開始日
ChargeStopDate		半角数字8桁課金停止日
NextChargeDate		半角数字8桁次回課金日次回の課金日を返却します。自動売上定義が課金停止日に到達しているか、解除されている場合は、空文字を返却します。 ※振替指定日を返却します。休日の場合、翌営業日が振替日となります。振替日は口座振替(セレクト) カレンダーを参照ください。
Method		課金手段 "RECURRING_SELECT"(口座振替セレクト)を返却します。
SiteID		半角英数13桁サイトID
MemberID		半角英数記号60桁会員ID
Remarks		半角英数カナ記号15桁請求内容
CheckMode		半角英数16桁口座有効性チェックモード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系口座振替

ShopID=tshop11223344&RecurringID=recurringid001&Amount=50&Tax=0&ChargeDay=27&ChargeMonth=05&ChargeStartDate=20221212&ChargeStopDate=&NextChargeDate=20230527&Method=RECURRING_ACCOUNTTRANS&CardNo=&Expire=&SiteID=tsite99887902&MemberID=memberid001&PrintStr=ｷｻｲﾅｲﾖｳ

レスポンスパラメータ：正常系口座振替セレクト

ShopID=tshop11223344&RecurringID=recurringid001&Amount=100&Tax=10&ChargeDay=05&ChargeMonth=02&ChargeStartDate=20221212&ChargeStopDate=&NextChargeDate=20230205&Method=RECURRING_SELECT&SiteID=tsite99887902&MemberID=memberid001&Remarks=ｾｲｷﾕｳﾅｲﾖｳ&CheckMode=

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchRecurringResult 自動売上処理結果

自動売上IDを指定して、自動売上処理結果を取得します。
決済手段により取得可能な処理結果対象およびデータ形式が異なります。

口座振替の場合

　当該自動売上IDに対する前回の自動売上処理結果が取得可能です。
　振込結果取得が可能な期間は、口振結果返却日の13:00～締切日の12:00の間です。
　上記以外の期間に結果取得を行った場合は、結果は返却されません。
　(口座振替のスケジュールについては、口座振替サービス(27日固定) カレンダーを参照ください。)

口座振替セレクトの場合

　当該自動売上IDに対する前回の自動売上処理結果が取得可能です。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
RecurringID		必須半角英数15桁自動売上ID 参照対象の自動売上IDを設定します。

URL

/payment/SearchRecurringResult.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&RecurringID=recurringid001

レスポンス

正常

口座振替

Method		課金手段 "RECURRING_ACCOUNTTRANS" (口座振替)を返却します。
ShopID		半角英数13桁ショップID
RecurringID		半角英数15桁自動売上ID
OrderID		半角英数記号27桁オーダーID 値は返却されません。
ChargeDate		半角数字8桁課金日値は返却されません。
Status		半角英字10桁振替依頼レコード状態振替依頼レコードの状態を返却します。 (空) ：自動売上未実施 INVALID：自動売上不可 (売上対象会員や口座が無効化された場合) REGISTER：自動売上処理中 SEND：金融機関処理中 CAPTURE：自動売上成功 FAIL：自動売上失敗 (失敗理由はResultを参照)
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
NextChargeDate		半角数字8桁次回課金日値は返却されません。
AccessID		半角英数32桁アクセスID 値は返却されません。
AccessPass		半角英数32桁アクセスパスワード値は返却されません。
Forward		仕向先コード値は返却されません。
ApprovalNo		承認番号値は返却されません。
SiteID		半角英数13桁サイトID
MemberID		半角英数記号60桁会員ID
PrintStr		半角カナ数字記号15桁通帳記載内容
Result		半角英数1桁振替結果詳細コード振替結果の詳細コードです。 0：引き落とし成功 1：残高不足 2：預金取引なし（口座が解約されている場合等） 3：預金者都合による振替停止 4：振替依頼書不備（依頼書の未着、不備返却等） 8：委託者都合による停止 9,E：その他 N：振替結果不明
ChargeErrCode		半角英数3桁固定自動売上エラーコード
ChargeErrInfo		半角英数9桁固定自動売上エラー詳細コード
ProcessDate		処理日時値は返却されません。

口座振替セレクト

Method		課金手段 "RECURRING_SELECT" (口座振替セレクト)を返却します。
SiteID		半角英数13桁サイトID
MemberID		半角英数記号60桁会員ID
ShopID		半角英数13桁ショップID
Amount		半角数字7桁利用金額
Tax		半角数字7桁税送料
Remarks		半角英数カナ記号15桁請求内容
RecurringID		半角英数15桁自動売上ID
Status		半角英字10桁振替依頼レコード状態振替依頼レコードの状態を返却します。 (空) ：自動売上未実施 INVALID：自動売上不可 (売上対象会員や口座が無効化された場合) REGIST：自動売上処理中 SEND：金融機関処理中 CAPTURE：自動売上成功 FAIL：自動売上失敗 (失敗理由はResultを参照)
Result		半角英数1桁振替結果詳細コード振替結果の詳細コードです。 0：請求成功 1：資金不足 2：預金取引なし 3：預金者都合による振替停止 4：預金口座振替依頼書なし 8：委託者の都合による振替停止 9：その他 E：請求不能 N：振替結果未着
ChargeErrCode		半角英数3桁固定自動売上エラーコード
ChargeErrInfo		半角英数9桁固定自動売上エラー詳細コード

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系口座振替

Method=RECURRING_ACCOUNTTRANS&ShopID=tshop11223344&RecurringID=recurringid001&OrderID=&ChargeDate=&Status=REGISTER&Amount=10000&Tax=0&NextChargeDate=&AccessID=&AccessPass=&Forward=&ApprovalNo=&SiteID=tsite99887902&MemberID=memberid001&PrintStr=ﾃｽﾄ&Result=&ChargeErrCode=&ChargeErrInfo=&ProcessDate=

レスポンスパラメータ：正常系口座振替セレクト

Method=RECURRING_SELECT&SiteID=tsite99887902&MemberID=memberid001&ShopID=tshop11223344&Amount=8000&Tax=0&Remarks=&RecurringID=recurringid001&Status=CAPTURE&Result=0&ChargeErrCode=&ChargeErrInfo=

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchRecurringResultFile 自動売上処理結果ファイル参照

課金手段と課金日付を指定して、自動売上結果を参照します。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
Method		必須課金手段取得対象の課金手段を設定します。 "RECURRING_ACCOUNTTRANS" ：口座振替 "RECURRING_SELECT" ：口座振替セレクト
ChargeDate		必須半角数字8桁固定課金日付取得対象の課金日付を設定します。 yyyyMMdd形式

URL

/payment/SearchRecurringResultFile.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&Method=RECURRING_ACCOUNTTRANS&ChargeDate=20220801

レスポンス

入力パラメータの「課金手段」「課金日付」に該当する売上ファイルが存在した場合は、売上ファイルの内容をレスポンスボディに設定して返します。
レスポンスの詳細については、こちらを参照ください

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001